Profile

_{Version: 1.0.0.0 Updated: 2023-11-29 16:56:05}

Summary

Documentation for the Profile Page

Profile Schema

Name	Type	Required	Description
join_mode	object	No	See schema
rank_id	string	Yes	Which rank this queue should use MMR from to make matches from, and update at the end of match (1v1 MMR or 2v2 MMR for example)
num_sides	integer	Yes	The number of sides a game in this queue will have (2 in a 1v1 and 3 in a 1v1v1 for example
min_players_per_side	integer	Yes	The minimum number of players that can be on each team
max_players_per_side	integer	Yes	The maximum number of players that can be on each team
min_players_per_linking	integer	Yes	The minimum number of players that can be on a single linking (a party)
max_players_per_linking	integer	Yes	The maximum number of players that can be on a single linking (a party)
max_side_delta	integer	Yes	The maximum difference in players per side when generating a match from this profile
instance_request_template_id	string	Yes	Which instance request template is used for matches generated from this profile
taskforce_size_by_time	object	No	See schema
match_making_function_config	object	Yes	See schema
match_making_stride_id	string	Yes	Which matchmaking strides should be used to divide the queue population
crossplay_partition_id	string	Yes	Which set of CrossplayPartitions rules should be used when generating matches in this profile
legacy_config	object	No	See schema
quality_by_time	object	No	See schema
active	boolean	Yes	Flag determining whether or not this profile will actively be ticked
supports_backfill	boolean	Yes	Flag determining whether or not backfill objects should be created when generating matches in this profile
sandbox_id	string	No	ID of the Sandbox
last_modified_account_id	string	No	Account ID of the user who last modified the resource
last_modified_timestamp	string	No	Timestamp of when the resource was last modified
created_timestamp	string	No	Timestamp of when this resource was created
match_making_profile_id	string	Yes	ID to uniquely identify this MatchMakingProfile

quality_by_time Schema

Name	Type	Required	Description
max_quality	number	No	The quality threshold that this profile will start trying to match with
max_minutes	number	No	The max amount of time we will try to create matches before quality will be disregarded
method	object	No	See schema

Quality by time defines the way in which the minimum skill of quality of a match reduces over seconds a player has waited in the queue. Must specificy which method will be used to to interpret the object in the property "method."

Example: {"method": "two_term_quadratic", "max_quality": 0.55, "max_minutes": 1.5}

In the example given, the chosen method is "two_term_quadratic." Additional properties are set to specify that the maximum quality will 0.55 and the maximum amount of minutes before accepting any quality match will be 1.5.

The threshold is calculated using the formula Q(t) = A - B * t **2

• t is the number of minutes in the queue of the Linking in the queue the longest
• A is the maximum quality
• B is (max_quality / max_minutes**2)

Join_mode Enum Values

Value	Description
normal	Mode that determines what types of match requests the ticket will appear in
backfill	Mode that determines what types of match requests the ticket will appear in
created_before	Mode that determines what types of match requests the ticket will appear in

Taskforce_size_by_time Schema

Name	Type	Required	Description
min_decayed_size	integer	Yes	The minimum size this taskforce can decay to
starting_size	integer	Yes	How big the taskforce should be before any decay has occurred
decay_power	integer	Yes	At what rate should the decay occur. 1 is linear, 2 quadratic etc
max_minutes	number	Yes	How many minutes it will take for the taskforce size to fully decay

Match_making_function_config Schema

Name	Type	Required	Description
host	string	No	The name of the matchmaking function that will be used to propose matches
port	integer	No	Which port the specified matchmaking function listens on
type	object	No	See schema

Type Enum Values

Value	Description
GRPC	An enumeration.
REST	An enumeration.

Legacy_config Schema

Name	Type	Required	Description
queue_type_value_id	integer	No	Queue type
task_force_number	integer	No	How many taskforces are in a match
name_msg_id	integer	No	The message id of this Profile
desc_msg_id	integer	No	The description message id of this Profile
give_xp_flag	boolean	No	Whether matches should award xp
giveachievement	boolean	No	Whether matches should award achievements
block_reward_after_level	boolean	No	Whether or not rewards have a level limit
servertickrate	integer	No	The server tick rate
serverfubartickrate	integer	No	Tick rate threshold before the instance is considered fubar
playerconnectwait	integer	No	How long to wait to allow players to connect
physicsthreshold	number	No	The threshold of acceptable physics
PerformanceGroup	integer	No	Which performance group instances for this match belong to
game_mode_value_id	integer	No	The game mode ValidValue
SurveyFreq	integer	No	How frequently a match should be surveyed
NoTaskforceSelection	boolean	No	Whether or not players should be allowed to choose their own taskforce
RecordClientStats	boolean	No	Whether or not client stats should be recorded
ServerDBStatWriteSeconds	integer	No	How frequently stats should be written to the DB
min_players_per_team	integer	No	Minimum number of players required on each team
max_players_per_team	integer	No	Maximum number of players allowed on each team
allowlivespectate	boolean	No	Whether or not these matches can be spectated without a delay
match_queue_id	integer	No	Queue id
deserter_flag	boolean	No	Whether or not leaving these matches should give deserter
ranking_type_id	integer	No	Rank id
game_type_value_id	integer	No	Game type ValidValue
PeerToPeer	boolean	No	Whether or not game should be hosted as P2P

method Enum Values

Value	Description
two_term_quadratic	An enumeration.